Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Cognitive Services 2025-04-01 #32877

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Cognitive Services 2025-04-01 #32877

wants to merge 12 commits into from

Conversation

ZhidaLiu
Copy link
Member

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

@ZhidaLiu
Copy files from stable/2024-10-01
5cb164f 
Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.
@ZhidaLiu
Update version to preview/2025-04-01-preview
734b721 
Updated the API version from stable/2024-10-01 to preview/2025-04-01-preview.
@ZhidaLiu
Added tag for 2025-04-01-preview in readme file
c646a23
@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Feb 27, 2025 •
edited
Loading

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This PR is in purview of the ARM review (label: ARMReview). This PR must get ARMSignedOff label from an ARM reviewer.
    This PR has ARMChangesRequested label. Please address or respond to feedback from the ARM API reviewer.
    When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
    Automation should then add WaitForARMFeedback label.
    ❗If you don't have permissions to remove the label, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories.
    For details of the ARM review, see aka.ms/azsdk/pr-arm-review
  • ❌ The required check named Breaking Change(Cross-Version) has failed. To unblock this PR, follow the process at aka.ms/brch.

@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Feb 27, 2025 •
edited
Loading

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

@github-actions github-actions bot added the brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. label Feb 27, 2025
This was referenced Feb 27, 2025
Draft
Draft
Draft
@ZhidaLiu ZhidaLiu force-pushed the user/zhili/CogSvc-2025-04-01-preview branch from ea7a9fb to 072c0b0 Compare February 27, 2025 04:56
@AzureRestAPISpecReview AzureRestAPISpecReview added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Feb 27, 2025
@AzureRestAPISpecReview AzureRestAPISpecReview removed the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Feb 27, 2025
@ZhidaLiu ZhidaLiu marked this pull request as ready for review February 27, 2025 20:50
@ZhidaLiu ZhidaLiu requested a review from yangyuan as a code owner February 27, 2025 20:50
@ZhidaLiu
Copy link
Member Author

The connection and capabilityHost APIs and schema are directly copied from AML RP located in:

azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2025-01-01-preview/workspaceRP.json

Line 463 in c39f72c

"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}": {

we would like to keep the schema unchanged

@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview new-api-version WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Feb 27, 2025
@ZhidaLiu ZhidaLiu added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Feb 28, 2025
@debuggerXi
Copy link
Member

To ARM reviewer: we own both Microsoft.CognitiveServices and Microsoft.MachineLearningServices RP now and working on a critical changes bringing some AML apis into Cognitive Service namespace. These APIs and contracts have been already reviewed in the latest AML swagger.
This is crucial to unblock AI Agent scenario in //Build. Please help prioritize the review. Thank you.

@razvanbadea-msft
Copy link
Contributor 

          "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"

if you are updating to a new version you should use v5/v6

Refers to: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json:90 in bc07055. [](commit_id = bc07055, deletion_comment = False)

@razvanbadea-msft
Copy link
Contributor 

      "additionalProperties": {

Use of additionalProperties is not allowed for properties owned by the service. The only time its ok to use it is when the properties are pass thru (user defined) and not subject to any validations. Please make this an array or provide an explanation for why you need this.

Refers to: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json:8782 in bc07055. [](commit_id = bc07055, deletion_comment = False)

@razvanbadea-msft
Copy link
Contributor 

"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}": {

check errors in LintDiff regarding projects rt. I did not see this copied from MachineLearningServices

Refers to: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json:3709 in bc07055. [](commit_id = bc07055, deletion_comment = False)

@razvanbadea-msft
Copy link
Contributor 

"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/connections/{connectionName}": {

same about this parte. This pr includes new features and features already approved, maybe it is better to split it in 2 prs so the review will go faster or mention what you are adding extra of MachineLearningServices resources types. and fix the errors for this ones

Refers to: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-04-01-preview/cognitiveservices.json:3973 in bc07055. [](commit_id = bc07055, deletion_comment = False)

@razvanbadea-msft razvanbadea-msft added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Feb 28, 2025
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Feb 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@yangyuan yangyuan Awaiting requested review from yangyuan yangyuan is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review ARMReview brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. Cognitive Services new-api-version PublishToCustomers Acknowledgement the changes will be published to Azure customers. resource-manager
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ZhidaLiu @debuggerXi @razvanbadea-msft @AzureRestAPISpecReview